Include Doxygen Participant page in Algolia search index#743
Open
vagxrth wants to merge 2 commits intoprecice:masterfrom
Open
Include Doxygen Participant page in Algolia search index#743vagxrth wants to merge 2 commits intoprecice:masterfrom
vagxrth wants to merge 2 commits intoprecice:masterfrom
Conversation
MakisH
added
GSoC
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #395
The Doxygen-generated Participant class API reference (
/doxygen/main/classprecice_1_1Participant.html) is not discoverable via the website's Algolia search because Doxygen HTML is built separately from Jekyll and never indexed byjekyll algolia.This PR adds a
before_indexing_allhook that parses the Doxygen Participant page and injects its methods into the Algolia index alongside regular Jekyll records.Changes
_plugins/algolia_hooks.rb(new): Parses the Doxygen Participant HTML with Nokogiri, extracts 1 class overview record + 1 record per public method (38 methods, 39 total). Skips gracefully with a warning if Doxygen HTML is not present (e.g. local builds)..github/workflows/update-algolia.yml: Adds steps to checkoutprecice/precicemain, patch the Doxyfile, build Doxygen HTML, and place it at_doxygen_html/main/before runningjekyll algolia.js/algolia-search.js: Handles missinganchorfield to prevent URLs ending in#undefined._config.yml: Excludes_doxygen_html/from Jekyll processing..gitignore: Ignores_doxygen_html/directory.